package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.CompanySysNoticeAddDTO;
import org.jsola.hr.dto.CompanySysNoticeOfflineDTO;
import org.jsola.hr.dto.CompanySysNoticeUpdateDTO;
import org.jsola.hr.query.CompanySysNoticeQuery;
import org.jsola.hr.vo.CompanySysNoticeListVO;
import org.jsola.hr.vo.CompanySysNoticeVO;
import org.jsola.hr.vo.UserCompanySysNoticeListVO;

import java.util.List;

/**
 * 公司系统公告信息
 *
 * @author zhr
 */
@Api(tags = "hr-公司系统公告信息")
public interface ICompanySysNoticeControllerAPI {

    /**
     * 新增公司系统公告信息
     * @param companySysNoticeAddDTO 公司系统公告信息新增实体
     * @return 公司系统公告信息展示对象
     */
    @ApiOperation(value = "新增公司系统公告信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companySysNoticeAddDTO", dataType = "CompanySysNoticeAddDTO", value = "新增公司系统公告信息", paramType = "body")
    })
    Result<CompanySysNoticeVO> save(CompanySysNoticeAddDTO companySysNoticeAddDTO);


    /**
     * 修改公司系统公告信息
     * @param companySysNoticeUpdateDTO 公司系统公告信息
     * @return 更新数量
     */
    @ApiOperation(value = "修改公司系统公告信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companySysNoticeUpdateDTO", dataType = "CompanySysNoticeUpdateDTO", value = "修改公司系统公告信息", paramType = "body")
    })
    Result<Integer> update(CompanySysNoticeUpdateDTO companySysNoticeUpdateDTO);




    /**
     * 删除单个公司系统公告信息，彻底删除
     * @param companySysNoticeId 公司系统公告信息id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个公司系统公告信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companySysNoticeId", dataType = "String", value = "公司系统公告信息id", paramType = "path")
    })
    Result<Integer> delete(String companySysNoticeId);


    /**
     * 批量删除公司系统公告信息，彻底删除
     * @param companySysNoticeIds 公司系统公告信息id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除公司系统公告信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companySysNoticeIds", dataType = "String[]", value = "公司系统公告信息id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] companySysNoticeIds);


    /**
     * 根据公司系统公告信息id查询公司系统公告信息详情
     * @param companySysNoticeId 公司系统公告信息id
     * @return 公司系统公告信息详情
     */
    @ApiOperation(value="根据公司系统公告信息id查询公司系统公告信息详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companySysNoticeId", dataType = "String", value = "公司系统公告信息id", paramType = "path")
    })
    Result<CompanySysNoticeVO> findById(String companySysNoticeId);


    /**
     * 查询公司系统公告信息
     * @param companySysNoticeQuery 公司系统公告信息查询参数
     * @return page
     */
    @ApiOperation(value="查询公司系统公告信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companySysNoticeQuery", dataType = "CompanySysNoticeQuery", value = "公司系统公告信息查询参数", paramType = "query")
    })
    Result<List<CompanySysNoticeListVO>> listAll(CompanySysNoticeQuery companySysNoticeQuery);


    /**
     * 分页查询公司系统公告信息
     * @param companySysNoticeQuery 公司系统公告信息查询参数
     * @return page
     */
    @ApiOperation(value="分页查询公司系统公告信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companySysNoticeQuery", dataType = "CompanySysNoticeQuery", value = "公司系统公告信息查询参数", paramType = "query")
    })
    Result<Page<CompanySysNoticeListVO>> page(CompanySysNoticeQuery companySysNoticeQuery);


    /**
     * 上线公告
     *
     * @param companySysNoticeId 公司系统公告信息
     * @return 更新数量
     */
    @ApiOperation(value = "上线公告")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companySysNoticeId", dataType = "String", value = "公司系统公告信息id", paramType = "path")
    })
    Result<String> onlineNotice(String companySysNoticeId);


    /**
     * 下线公告
     *
     * @param companySysNoticeId         公司系统公告信息
     * @param companySysNoticeOfflineDTO 下线公告的参数
     * @return 更新数量
     */
    @ApiOperation(value = "下线公告")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companySysNoticeId", dataType = "String", value = "公司系统公告信息id", paramType = "path"),
            @ApiImplicitParam(name = "companySysNoticeOfflineDTO", dataType = "CompanySysNoticeOfflineDTO", value = "下线公告的参数", paramType = "body")
    })
    Result<String> offlineNotice(String companySysNoticeId, CompanySysNoticeOfflineDTO companySysNoticeOfflineDTO);

    /**
     * 置顶公告
     *
     * @param companySysNoticeId 公司系统公告信息
     * @return 更新数量
     */
    @ApiOperation(value = "置顶公告")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companySysNoticeId", dataType = "String", value = "公司系统公告信息id", paramType = "path")
    })
    Result<String> topNotice(String companySysNoticeId);

    /**
     * 取消置顶公告
     *
     * @param companySysNoticeId 公司系统公告信息
     * @return 更新数量
     */
    @ApiOperation(value = "取消置顶公告")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companySysNoticeId", dataType = "String", value = "公司系统公告信息id", paramType = "path")
    })
    Result<String> upTopNotice(String companySysNoticeId);

    /**
     * 分页查询公司系统公告信息
     *
     * @param companyId             公司id
     * @param companySysNoticeQuery 公司系统公告信息查询参数
     * @return page
     */
    @ApiOperation(value = "分页查询公司系统公告信息(管理员查看)")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyId", dataType = "String", value = "公司id", paramType = "path"),
            @ApiImplicitParam(name = "companySysNoticeQuery", dataType = "CompanySysNoticeQuery", value = "公司系统公告信息查询参数", paramType = "query")
    })
    Result<Page<CompanySysNoticeListVO>> pageByCompany(String companyId, CompanySysNoticeQuery companySysNoticeQuery);

    /**
     * 查询公司系统公告信息
     *
     * @param companySysNoticeQuery 公司系统公告信息查询参数
     * @return page
     */
    @ApiOperation(value = "公告接收人获取自己在某公司的公告")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyId", dataType = "String", value = "公司id", paramType = "path"),
            @ApiImplicitParam(name = "sysNoticeQuery", dataType = "SysNoticeQuery", value = "公告信息查询参数", paramType = "query")
    })
    Result<List<UserCompanySysNoticeListVO>> listSysNoticeByUser(String companyId, CompanySysNoticeQuery companySysNoticeQuery);

    /**
     * 查询公司系统公告信息
     *
     * @param companySysNoticeQuery 公司系统公告信息查询参数
     * @return page
     */
    @ApiOperation(value = "公告接收人获取自己在某公司的公告(分页展示)")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyId", dataType = "String", value = "公司id", paramType = "path"),
            @ApiImplicitParam(name = "sysNoticeQuery", dataType = "SysNoticeQuery", value = "公告信息查询参数", paramType = "query")
    })
    Result<Page<UserCompanySysNoticeListVO>> pageSysNoticeByUser(String companyId, CompanySysNoticeQuery companySysNoticeQuery);

    /**
     * 查询公司系统公告信息
     *
     * @param sysNoticeId 系统公告id
     * @return page
     */
    @ApiOperation(value = "根据系统公告id获取公告详情(公告接收人用)")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "sysNoticeId", dataType = "String", value = "公告id", paramType = "path")
    })
    Result<UserCompanySysNoticeListVO> findSysNoticeByUser(String sysNoticeId);

    /**
     * 将某一系统公告置为已读
     *
     * @param sysNoticeId 系统公告id
     * @return page
     */
    @ApiOperation(value = "将某一系统公告置为已读(公告接收人用)")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "sysNoticeId", dataType = "String", value = "公告id", paramType = "path")
    })
    Result<String> readSysNotice(String sysNoticeId);

    /**
     * 将某一系统公告置为已读
     *
     * @param sysNoticeIds 系统公告id
     * @return page
     */
    @ApiOperation(value = "批量删除用户接收到的公告(公告接收人用)")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "sysNoticeIds", dataType = "String", value = "公告id数组", paramType = "body", allowMultiple = true)
    })
    Result<String> deleteUserSysNotice(String[] sysNoticeIds);
}

